View Javadoc

1   /***
2    * Redistribution and use of this software and associated documentation
3    * ("Software"), with or without modification, are permitted provided
4    * that the following conditions are met:
5    *
6    * 1. Redistributions of source code must retain copyright
7    *    statements and notices.  Redistributions must also contain a
8    *    copy of this document.
9    *
10   * 2. Redistributions in binary form must reproduce the
11   *    above copyright notice, this list of conditions and the
12   *    following disclaimer in the documentation and/or other
13   *    materials provided with the distribution.
14   *
15   * 3. The name "Exolab" must not be used to endorse or promote
16   *    products derived from this Software without prior written
17   *    permission of Exoffice Technologies.  For written permission,
18   *    please contact info@exolab.org.
19   *
20   * 4. Products derived from this Software may not be called "Exolab"
21   *    nor may "Exolab" appear in their names without prior written
22   *    permission of Exoffice Technologies. Exolab is a registered
23   *    trademark of Exoffice Technologies.
24   *
25   * 5. Due credit should be given to the Exolab Project
26   *    (http://www.exolab.org/).
27   *
28   * THIS SOFTWARE IS PROVIDED BY EXOFFICE TECHNOLOGIES AND CONTRIBUTORS
29   * ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
30   * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
31   * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL
32   * EXOFFICE TECHNOLOGIES OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
33   * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
34   * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
35   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
36   * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
37   * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
38   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
39   * OF THE POSSIBILITY OF SUCH DAMAGE.
40   *
41   * Copyright 2004-2006 (C) Exoffice Technologies Inc. All Rights Reserved.
42   *
43   * $Id: SocketInfo.java,v 1.1 2006/01/11 13:24:05 tanderson Exp $
44   */
45  package org.exolab.jms.net.tunnel;
46  
47  import java.net.Socket;
48  
49  
50  /***
51   * Maintains connection information for {@link TunnelServlet}.
52   *
53   * @author <a href="mailto:tma@netspace.net.au">Tim Anderson</a>
54   * @version $Revision: 1.1 $ $Date: 2006/01/11 13:24:05 $
55   */
56  class SocketInfo {
57  
58      /***
59       * The connection identifier.
60       */
61      private final String _id;
62  
63      /***
64       * The time that the socket was last used, in milliseconds.
65       */
66      private long _used = 0;
67  
68      /***
69       * The socket.
70       */
71      private final Socket _socket;
72  
73  
74      /***
75       * Construct a new <code>SocketInfo</code>.
76       *
77       * @param id       the connection identifier
78       * @param socket the endpoint
79       */
80      public SocketInfo(String id, Socket socket) {
81          _id = id;
82          _socket = socket;
83          setUsed();
84      }
85  
86      /***
87       * Returns the connection identifier.
88       *
89       * @return the connection identifier
90       */
91      public String getId() {
92          return _id;
93      }
94  
95      /***
96       * Returns the socket.
97       *
98       * @return the socket
99       */
100     public Socket getSocket() {
101         return _socket;
102     }
103 
104     /***
105      * Sets the time when the socket was last used.
106      */
107     public void setUsed() {
108         _used = System.currentTimeMillis();
109     }
110 
111     /***
112      * Returns the time when the socket was last used.
113      *
114      * @return the time when the socket was last used, in milliseconds
115      */
116     public long getUsed() {
117         return _used;
118     }
119 
120 }